docs: add docs for GtkTextAppearance
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 21 Jan 2014 18:14:34 +0000 (13:14 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 21 Jan 2014 18:33:47 +0000 (13:33 -0500)
gtk/gtktextattributes.h

index 2669e0f4ec6651629527a4754b90d9b707dd5794..b64e0e7b31feaec64c62e7c34ee6c9c1a2e2f050 100644 (file)
@@ -67,6 +67,25 @@ typedef struct _GtkTextAttributes GtkTextAttributes;
 
 typedef struct _GtkTextAppearance GtkTextAppearance;
 
+/**
+ * GtkTextAppearance:
+ * @bg_color: Background #GdkColor.
+ * @fg_color: Foreground #GdkColor.
+ * @rise: Super/subscript rise, can be negative.
+ * @underline: #PangoUnderline
+ * @strikethrough: Strikethrough style
+ * @draw_bg: Whether to use background-related values; this is
+ *   irrelevant for the values struct when in a tag, but is used for
+ *   the composite values struct; it's true if any of the tags being
+ *   composited had background stuff set.
+ * @inside_selection: This are only used when we are actually laying
+ *   out and rendering a paragraph; not when a #GtkTextAppearance is
+ *   part of a #GtkTextAttributes.
+ * @is_text: This are only used when we are actually laying
+ *   out and rendering a paragraph; not when a #GtkTextAppearance is
+ *   part of a #GtkTextAttributes.
+ * @rgba: #GdkRGBA
+ */
 struct _GtkTextAppearance
 {
   /*< public >*/
@@ -76,7 +95,6 @@ struct _GtkTextAppearance
   /* super/subscript rise, can be negative */
   gint rise;
 
-  /*< public >*/
   guint underline : 4;          /* PangoUnderline */
   guint strikethrough : 1;
 
@@ -103,12 +121,14 @@ struct _GtkTextAppearance
    */
   union {
     GdkRGBA *rgba[2];
+    /*< private >*/
     guint padding[4];
   };
 #else
   GdkRGBA *rgba[2];
 #if (defined(__SIZEOF_INT__) && defined(__SIZEOF_POINTER__)) && (__SIZEOF_INT__ == __SIZEOF_POINTER__)
   /* unusable, just for ABI compat */
+  /*< private >*/
   guint padding[2];
 #endif
 #endif